Clarify parameters vs properties with diagram #28
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Enhanced the parameters-properties.md documentation to address common confusion about when to use each approach: - Added "Quick Decision Guide" section upfront for immediate clarity - Included mermaid sequence diagram showing execution flow and variable lifespan throughout the build process - Restructured content with clear "When to Use" sections for both parameters (input values) and properties (final overrides) - Added side-by-side comparison examples demonstrating the timing difference - Included comparison table highlighting key differences - Added "Best Practices" section with real-world guidance - Added warning about properties not recomputing derived values - Concluded with summary and "Rule of Thumb" decision tip The document now provides a clear decision framework for users to determine which approach to use based on whether values are used for computation or are final overrides.
✅ Deploy Preview for psake ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Installed and configured @docusaurus/theme-mermaid to enable mermaid diagrams in markdown files: - Added @docusaurus/[email protected] (matching core version) - Configured markdown.mermaid: true in docusaurus.config.ts - Added mermaid theme to themes array This enables the sequence diagram in the parameters-properties documentation to render correctly, showing the execution flow and variable lifespan throughout the build process.
HeyItsGilbert
deleted the
claude/clarify-parameters-properties-01BC5fViN7XVU47CXdzLM2Q4
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Enhanced the parameters-properties.md documentation to address common confusion about when to use each approach:
The document now provides a clear decision framework for users to determine which approach to use based on whether values are used for computation or are final overrides.